<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package metaface.interaction;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.*;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.io.*;<a name="line.4"></a>
<FONT color="green">005</FONT>    /**<a name="line.5"></a>
<FONT color="green">006</FONT>     *  This clas represents a subtopic DMTL element and is used to organsise the<a name="line.6"></a>
<FONT color="green">007</FONT>     *  structure and searching strategy.&lt;p><a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *@author     Simon Beard <a name="line.9"></a>
<FONT color="green">010</FONT>     *@version    1.0<a name="line.10"></a>
<FONT color="green">011</FONT>     *@see        InteractionManager <a name="line.11"></a>
<FONT color="green">012</FONT>     *@see        SubTopic<a name="line.12"></a>
<FONT color="green">013</FONT>     */<a name="line.13"></a>
<FONT color="green">014</FONT>    public class Topic {<a name="line.14"></a>
<FONT color="green">015</FONT>            /**<a name="line.15"></a>
<FONT color="green">016</FONT>             *  DMTL name of the topic<a name="line.16"></a>
<FONT color="green">017</FONT>             */     <a name="line.17"></a>
<FONT color="green">018</FONT>            private String name;<a name="line.18"></a>
<FONT color="green">019</FONT>            /**<a name="line.19"></a>
<FONT color="green">020</FONT>             *  Subtopics within this topic<a name="line.20"></a>
<FONT color="green">021</FONT>             */     <a name="line.21"></a>
<FONT color="green">022</FONT>            private Vector subtopics;<a name="line.22"></a>
<FONT color="green">023</FONT>            /**<a name="line.23"></a>
<FONT color="green">024</FONT>             *  Was this topic visited in the previous interaction<a name="line.24"></a>
<FONT color="green">025</FONT>             */     <a name="line.25"></a>
<FONT color="green">026</FONT>            private boolean visited = false;<a name="line.26"></a>
<FONT color="green">027</FONT>    <a name="line.27"></a>
<FONT color="green">028</FONT>    <a name="line.28"></a>
<FONT color="green">029</FONT>            /**<a name="line.29"></a>
<FONT color="green">030</FONT>             *  Constructor for the Topic object<a name="line.30"></a>
<FONT color="green">031</FONT>             *<a name="line.31"></a>
<FONT color="green">032</FONT>             *@param  namestring      The DMTL name of the topic<a name="line.32"></a>
<FONT color="green">033</FONT>             */<a name="line.33"></a>
<FONT color="green">034</FONT>            public Topic(String namestring) {<a name="line.34"></a>
<FONT color="green">035</FONT>                    name = new String(namestring);<a name="line.35"></a>
<FONT color="green">036</FONT>                    subtopics = new Vector();<a name="line.36"></a>
<FONT color="green">037</FONT>                    visited = false;<a name="line.37"></a>
<FONT color="green">038</FONT>            }<a name="line.38"></a>
<FONT color="green">039</FONT>    <a name="line.39"></a>
<FONT color="green">040</FONT>    <a name="line.40"></a>
<FONT color="green">041</FONT>            /**<a name="line.41"></a>
<FONT color="green">042</FONT>             *  Adds a subtopic to the Topic object<a name="line.42"></a>
<FONT color="green">043</FONT>             *<a name="line.43"></a>
<FONT color="green">044</FONT>             *@param  element  The subtopic to add<a name="line.44"></a>
<FONT color="green">045</FONT>             */<a name="line.45"></a>
<FONT color="green">046</FONT>            public void addSubTopic(SubTopic element) {<a name="line.46"></a>
<FONT color="green">047</FONT>                    subtopics.add(element);<a name="line.47"></a>
<FONT color="green">048</FONT>            }<a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>            /**<a name="line.51"></a>
<FONT color="green">052</FONT>             *  Gets the name attribute of the Topic<a name="line.52"></a>
<FONT color="green">053</FONT>             *<a name="line.53"></a>
<FONT color="green">054</FONT>             *@return    The DMTL name<a name="line.54"></a>
<FONT color="green">055</FONT>             */<a name="line.55"></a>
<FONT color="green">056</FONT>            public String getName() {<a name="line.56"></a>
<FONT color="green">057</FONT>                    return (name);<a name="line.57"></a>
<FONT color="green">058</FONT>            }<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>            /**<a name="line.61"></a>
<FONT color="green">062</FONT>             *  Gets the subtopics within the Topic object<a name="line.62"></a>
<FONT color="green">063</FONT>             *<a name="line.63"></a>
<FONT color="green">064</FONT>             *@return    The subtopics<a name="line.64"></a>
<FONT color="green">065</FONT>             */<a name="line.65"></a>
<FONT color="green">066</FONT>            public Vector getSubTopics() {<a name="line.66"></a>
<FONT color="green">067</FONT>                    return (subtopics);<a name="line.67"></a>
<FONT color="green">068</FONT>            }<a name="line.68"></a>
<FONT color="green">069</FONT>    <a name="line.69"></a>
<FONT color="green">070</FONT>    <a name="line.70"></a>
<FONT color="green">071</FONT>            /**<a name="line.71"></a>
<FONT color="green">072</FONT>             *  Any buiding instructions that must be completed after the constructor is<a name="line.72"></a>
<FONT color="green">073</FONT>             *  called<a name="line.73"></a>
<FONT color="green">074</FONT>             */<a name="line.74"></a>
<FONT color="green">075</FONT>            public void build() {<a name="line.75"></a>
<FONT color="green">076</FONT>            }<a name="line.76"></a>
<FONT color="green">077</FONT>    <a name="line.77"></a>
<FONT color="green">078</FONT>    <a name="line.78"></a>
<FONT color="green">079</FONT>            /**<a name="line.79"></a>
<FONT color="green">080</FONT>             *  Resets any internal state variables<a name="line.80"></a>
<FONT color="green">081</FONT>             */<a name="line.81"></a>
<FONT color="green">082</FONT>            public void reset() {<a name="line.82"></a>
<FONT color="green">083</FONT>                    visited = false;<a name="line.83"></a>
<FONT color="green">084</FONT>            }<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>    <a name="line.86"></a>
<FONT color="green">087</FONT>            /**<a name="line.87"></a>
<FONT color="green">088</FONT>             *  Performs a match on user stimulus such as natural language or a hypertext<a name="line.88"></a>
<FONT color="green">089</FONT>             *  link<a name="line.89"></a>
<FONT color="green">090</FONT>             *<a name="line.90"></a>
<FONT color="green">091</FONT>             *@param  ic        The current context of the interaction<a name="line.91"></a>
<FONT color="green">092</FONT>             *@param  path      A stack denoting the path (within the DMTL file) to this<a name="line.92"></a>
<FONT color="green">093</FONT>             *      state<a name="line.93"></a>
<FONT color="green">094</FONT>             *@param  bestlist  A list of the best matching states<a name="line.94"></a>
<FONT color="green">095</FONT>             *@return           The modified list of best matching states<a name="line.95"></a>
<FONT color="green">096</FONT>             */<a name="line.96"></a>
<FONT color="green">097</FONT>            public BestList matchStimulus(InteractionContext ic, Stack path, BestList bestlist) {<a name="line.97"></a>
<FONT color="green">098</FONT>                    int i;<a name="line.98"></a>
<FONT color="green">099</FONT>                    boolean process;<a name="line.99"></a>
<FONT color="green">100</FONT>                    SubTopic tmpsubtopic;<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>                    process = true;<a name="line.102"></a>
<FONT color="green">103</FONT>                    path.push(name);<a name="line.103"></a>
<FONT color="green">104</FONT>                    <a name="line.104"></a>
<FONT color="green">105</FONT>                    //Only process if visisted in the previous interaction (and processing ENTRY states)<a name="line.105"></a>
<FONT color="green">106</FONT>                    if ((ic.processingtype == InteractionManager.ENTRY) && (!visited)) {<a name="line.106"></a>
<FONT color="green">107</FONT>                            process = false;<a name="line.107"></a>
<FONT color="green">108</FONT>                    }<a name="line.108"></a>
<FONT color="green">109</FONT>                    if (process) {<a name="line.109"></a>
<FONT color="green">110</FONT>                            <a name="line.110"></a>
<FONT color="green">111</FONT>                            //Process all subtopics<a name="line.111"></a>
<FONT color="green">112</FONT>                            for (i = 0; i &lt; subtopics.size(); i++) {<a name="line.112"></a>
<FONT color="green">113</FONT>                                    tmpsubtopic = (SubTopic) subtopics.elementAt(i);<a name="line.113"></a>
<FONT color="green">114</FONT>                                    bestlist = tmpsubtopic.matchStimulus(ic, path, bestlist);<a name="line.114"></a>
<FONT color="green">115</FONT>                            }<a name="line.115"></a>
<FONT color="green">116</FONT>                    }<a name="line.116"></a>
<FONT color="green">117</FONT>                    path.pop();<a name="line.117"></a>
<FONT color="green">118</FONT>                    return (bestlist);<a name="line.118"></a>
<FONT color="green">119</FONT>            }<a name="line.119"></a>
<FONT color="green">120</FONT>    <a name="line.120"></a>
<FONT color="green">121</FONT>    <a name="line.121"></a>
<FONT color="green">122</FONT>            /**<a name="line.122"></a>
<FONT color="green">123</FONT>             *  Gets a response based on a state reference<a name="line.123"></a>
<FONT color="green">124</FONT>             *<a name="line.124"></a>
<FONT color="green">125</FONT>             *@param  path  The path to the response (state reference)<a name="line.125"></a>
<FONT color="green">126</FONT>             *@return       The response element<a name="line.126"></a>
<FONT color="green">127</FONT>             */<a name="line.127"></a>
<FONT color="green">128</FONT>            public Response getResponse(Stack path) {<a name="line.128"></a>
<FONT color="green">129</FONT>                    int i;<a name="line.129"></a>
<FONT color="green">130</FONT>                    SubTopic tmpsubtopic;<a name="line.130"></a>
<FONT color="green">131</FONT>                    String subtopicname;<a name="line.131"></a>
<FONT color="green">132</FONT>                    String temp;<a name="line.132"></a>
<FONT color="green">133</FONT>    <a name="line.133"></a>
<FONT color="green">134</FONT>                    visited = true;<a name="line.134"></a>
<FONT color="green">135</FONT>                    <a name="line.135"></a>
<FONT color="green">136</FONT>                    //Search all subtopics<a name="line.136"></a>
<FONT color="green">137</FONT>                    for (i = 0; i &lt; subtopics.size(); i++) {<a name="line.137"></a>
<FONT color="green">138</FONT>                            <a name="line.138"></a>
<FONT color="green">139</FONT>                            //If path name matches subtopic name -- process<a name="line.139"></a>
<FONT color="green">140</FONT>                            tmpsubtopic = (SubTopic) subtopics.elementAt(i);<a name="line.140"></a>
<FONT color="green">141</FONT>                            subtopicname = tmpsubtopic.getName();<a name="line.141"></a>
<FONT color="green">142</FONT>                            if (subtopicname.equalsIgnoreCase((String) (path.peek()))) {<a name="line.142"></a>
<FONT color="green">143</FONT>                                    temp = (String) path.pop();<a name="line.143"></a>
<FONT color="green">144</FONT>                                    if (DMTLDebugger.debug) {<a name="line.144"></a>
<FONT color="green">145</FONT>                                            System.out.println("Traversing: " + temp);<a name="line.145"></a>
<FONT color="green">146</FONT>                                    }<a name="line.146"></a>
<FONT color="green">147</FONT>                                    <a name="line.147"></a>
<FONT color="green">148</FONT>                                    //Get the response from the subtopic<a name="line.148"></a>
<FONT color="green">149</FONT>                                    return (tmpsubtopic.getResponse(path));<a name="line.149"></a>
<FONT color="green">150</FONT>                            }<a name="line.150"></a>
<FONT color="green">151</FONT>                    }<a name="line.151"></a>
<FONT color="green">152</FONT>                    return (null);<a name="line.152"></a>
<FONT color="green">153</FONT>            }<a name="line.153"></a>
<FONT color="green">154</FONT>    }<a name="line.154"></a>




























































</PRE>
</BODY>
</HTML>
